home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 3 / BBS in a box - Trilogy III.iso / Files / Tele / D-F / FSP 2.6 / FSP Quick Ref.⁄2.6 < prev    next >
Encoding:
Text File  |  1990-07-01  |  3.7 KB  |  124 lines  |  [TEXT/NISI]
  1. Symbols:
  2.     Upon initilization:
  3.  @1  :  Current month (1-12)
  4.  @2  :  Current Day   (1-31)
  5.  @3  :  DayOfWeek  ( 1-7, 1 = Sunday, 2 = Monday, ...)
  6.  Date : Date  ; e.g '7/12', '12/31'
  7.  Time : 24 hr time ; e.g. '4:01', '22:14'
  8.  
  9.  
  10. When a macro is called, @1-@3 are automatically defined as arguments.
  11.  
  12. No_Files   : YES is the file_cnt = 0;  NO if file entries are in memory.
  13.  
  14. Remote     : YES if Launch_RRH file is found on the same directory.
  15.  
  16. Used during ADD/FOLDER
  17. Desc_Prompt   
  18. Default_Level
  19. All_Files_Sect
  20. New_Files_Sect
  21.  
  22. Guards:
  23. Execute command if guard symbol = "" "YES" "TRUE" "NO-" "FALSE-"
  24.  
  25.  
  26. Commands:
  27.  
  28. * Symbol defining commands
  29. DEFINE        "<symbol>" "<definition>"  "<guard>"
  30. DEFINE/NOMAP    "<symbol>" "<definition>"  "<guard>"
  31. SHOWSYMBOL    "<symbol>"
  32. CONCATENATE    "< object symbol>" "< source symbol >"  " source symbol >"
  33. EQUAL        "<flag>" "<symbol1>" " <symbol2>"  
  34. EQUAL/NOT    "<flag>" "<symbol1>" " <symbol2>"
  35. AND    "<new flag>" "<flag1>" "< flag1 >"  
  36. AND/NOT    "<new flag>" "<flag1>" "< flag1 >"
  37.  
  38. * Control commands
  39. SKIP           "<guard>" ; Skip 1 line
  40. SKIP "<Label>"       "<guard>"    ; Skip to label
  41. SKIP "#<number>"  "<guard>"    ; Skip <number> lines.
  42. SKIP "<Label>"    "<guard>"    ; Conditionally skip to label.
  43. SKIP "#<number>"  "<guard>"    ; Conditionally skip <number> lines.   
  44. END   "<guard>" 
  45. LAUNCH  "<Application name>" "<guard>"
  46. CHAIN  "<file name>"   "<Label>"  "<guard>"
  47. * The following add entries to list of file references.
  48. LOAD    "<file sect>" 
  49. ADD    "<file section name>" 
  50. ADD/FOLDER "<HFS Folder Name>"  "Guard"
  51. READTEXT "<Text file as written by SAVETEXT/LONG>" 
  52.  
  53. * These commands can remove entries.
  54. CLEAR 
  55. INTERSECT "<sect>" 
  56. SUBTRACT  "< file section name >"
  57. PURGE  "<Guard>" 
  58. PURGE/DELETE  "Guard>"  ; Purges deleted entries and deletes actual file.
  59.  
  60. * These reorder entries.
  61. SORT/DATE, SORT/TITLE, SORT/PATH, SORT/UPLDR, SORT/SIZE, SORT/DLDATE, SORT/DLCNT     
  62. INVERT 
  63.  
  64. * These commands all write to disk.
  65. SAVE  "<file sect>" "<guard>
  66. SAVE/DELETE "<file sect>" "<guard> ; Save deleted entries.
  67. ADDTO        "<file section name>" 
  68. ADDTO/DELETE    "<file section name>" 
  69. SAVETEXT[/<option>]   "<Text file name>"  "<guard>"
  70.    <option> :== LONG | DESC | PATH | FORMAT
  71.  
  72. * Modify pathnames
  73. CLEARPATH    "<guard>" 
  74. SETPATH "<new path>"  "<guard>"
  75. CHANGEPATH         "<new path>"  "<guard>"      
  76. *  Both MOVE and CHECKPATH require the symbol BBS
  77. * to be defined.
  78. CHECKPATH          "<Volume or Folder Name>"  "<guard>" 
  79. CHECKPATH/DELETE   "<Volume or Folder Name>"  "<guard>" 
  80. MOVE         "<Volume or Folder Name>"  "<guard>"  
  81. MOVE/UNDER   "<Volume or Folder Name>"  "<guard>"       
  82. MOVE/DELETE  "<Volume or Folder Name>"  "<guard>" 
  83. *
  84. CHECKTYPE   "<guard>" ; Modify file type field.
  85. * Change/set 'delete' flag.
  86. DELETE/DUPS     "<guard>"
  87. DELETE/AGE    "<n>"  "<guard>"
  88. DELETE/ALL     "<guard>"  ; Mark all entries as deleted.
  89. DELETE/NONE    "<guard>"  ; Mark all entries as NOT deleted.
  90. DELETE/TOGGLE  "<guard>"  ; Toggle delete flag on each entry.
  91. * Macro commands
  92. DEFINEMACRO "<MacroName>"
  93. ENDMACRO
  94. * Other
  95. DELETEFILE "<pathname of file to be deleted>" "<guard>"
  96. RENAMEFILE "<pathname of file to be renamed>" "new file name" "guard"
  97. FORMAT "<Field list>"
  98.  
  99. * Field names  (may be shortened) :
  100. TAB     Tab Char,
  101. CR      Carriage Return
  102. COL     Column number; used as COL:30
  103. SECT    Section Name
  104. DELE    Deleted Flag
  105. TITLE   Title
  106. SIZE    Size in Bytes
  107. SIZEK   Size rounded up to kilobytes.
  108. DESCA   All description lines.
  109. DESC    A description line.  Multiple uses refer to sucessive lines.
  110. TYPE    File Type (TEXT, Mac Appl., Mac Doc., Other)
  111. UPLDR   Uploader Name
  112. VERS    Version
  113. DATE    Date of Upload
  114. DLDATE  Last Date DLed
  115. CLRNC   Clearance/Privilege Level
  116. DLCNT   DL Count
  117. PATH    Path
  118. NAME    Actual file name. (Path with folder names stripped)
  119. END     END of Format
  120.  
  121.  
  122.  
  123.  
  124.